<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class config</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="ODTONE 0.4">
<link rel="up" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.config_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/mih/config.hpp&gt;">
<link rel="prev" href="is_oarchive/false_t.html" title="Class false_t">
<link rel="next" href="confirm.html" title="Class confirm">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="'ODTONE - Open Dot Twenty One'" width="100" height="100" src="../.././images/logo.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_oarchive/false_t.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.config_hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="confirm.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="odtone.mih.config"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class config</span></h2>
<p>odtone::mih::config</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.config_hpp" title="Header &lt;/home/carlos/Projectos/odtone/inc/odtone/mih/config.hpp&gt;">/home/carlos/Projectos/odtone/inc/odtone/mih/config.hpp</a>&gt;

</span>
<span class="keyword">class</span> <a class="link" href="config.html" title="Class config">config</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="config.html#odtone.mih.configconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="config.html#idp5226128-bb"><span class="identifier">config</span></a><span class="special">(</span><span class="identifier">po</span><span class="special">::</span><span class="identifier">options_description</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="config.html#idp5227184-bb"><span class="special">~</span><span class="identifier">config</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="config.html#idp5218880-bb">public member functions</a></span>
  <span class="keyword">bool</span> <a class="link" href="config.html#idp5219096-bb"><span class="identifier">help</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="config.html#idp5220216-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a class="link" href="config.html#idp5222848-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">uint</span> <a class="link" href="config.html#idp5224688-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp11187960"></a><h2>Description</h2>
<p>Configuration and command line options parser</p>
<p>This class provides parsing for command line options and configuration files for a set of predefined options description. </p>
<div class="refsect2">
<a name="idp11188608"></a><h3>
<a name="odtone.mih.configconstruct-copy-destruct"></a><code class="computeroutput">config</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp5226128-bb"></a><span class="identifier">config</span><span class="special">(</span><span class="identifier">po</span><span class="special">::</span><span class="identifier">options_description</span> <span class="special">&amp;</span> desc<span class="special">)</span><span class="special">;</span></pre>
<p>Construct a configuration and command line options parser.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">desc</code></span></p></td>
<td><p>A set of option descriptions. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp5227184-bb"></a><span class="special">~</span><span class="identifier">config</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Destruct a configuration and command line options parser. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp11197008"></a><h3>
<a name="idp5218880-bb"></a><code class="computeroutput">config</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp5219096-bb"></a><span class="identifier">help</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Check if the help option was specified.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>True if the help option is present or false otherwise. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp5220216-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">char</span> <span class="special">*</span> argv<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> conf_file_option<span class="special">)</span><span class="special">;</span></pre>
<p>Parse the command line arguments.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">argc</code></span></p></td>
<td><p>Number of arguments passed through the command line. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">argv</code></span></p></td>
<td><p>Arguments passed through the command line. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">conf_file_option</code></span></p></td>
<td><p>Name of configuration file. </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a name="idp5222848-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> var<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Get option variable value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">var</code></span></p></td>
<td><p>The variable name. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint</span> <a name="idp5224688-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> var<span class="special">)</span><span class="special">;</span></pre>
<p>Count the number of option variables.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><code class="computeroutput">var</code></span></p></td>
<td><p>Number of variables. </p></td>
</tr></tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Universidade
      Aveiro<br>Copyright &#169; 2009-2012 Instituto
      de Telecomunica&#231;&#245;es - P&#243;lo Aveiro<p>
        This software is distributed under a license. The full license agreement
        can be found in the LICENSE in this distribution. This software may not be
        copied, modified, sold or distributed other than expressed in the named license
        agreement. This software is distributed without any warranty.
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_oarchive/false_t.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../odtone_mih_library.html#header..home.carlos.Projectos.odtone.inc.odtone.mih.config_hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="confirm.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
